[Connect] docs fixes #4384
Merged
[Connect] docs fixes #4384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StripeConnect- public var delegate: (any StripeConnect.AccountOnboardingViewControllerDelegate)?
+ @objc deinit
+ func accountOnboardingDidExit(_ accountOnboarding: StripeConnect.AccountOnboardingViewController)
+ func accountOnboarding(_ accountOnboarding: StripeConnect.AccountOnboardingViewController, didFailLoadWithError error: any Swift.Error)
- public func accountOnboardingDidExit(_ accountOnboarding: StripeConnect.AccountOnboardingViewController)
- public func accountOnboarding(_ accountOnboarding: StripeConnect.AccountOnboardingViewController, didFailLoadWithError error: any Swift.Error)If you are adding a new public API consider the following:
If you are modifying or removing a public API:
If you confirm these APIs need to be added/updated and have undergone necessary review, add the label ℹ️ If this comment appears to be left in error, make sure your branch is up-to-date with |
mludowise-stripe
force-pushed
the
mludowise/MXMOBILE-3003_docs_readme
branch
2 times, most recently
from
b2e9b68 to
3300603
Compare
mludowise-stripe
changed the title
mludowise-stripe
force-pushed
the
mludowise/MXMOBILE-3003_docs_readme
branch
from
c4bb6ab to
11bc356
Compare
Comment on lines
+99
to
108
| @_documentation(visibility: public) | ||
| public extension AccountOnboardingViewControllerDelegate { | ||
| // Add default implementation of delegate methods to make them optional | ||
|
|
||
| @_documentation(visibility: public) | ||
| func accountOnboardingDidExit(_ accountOnboarding: AccountOnboardingViewController) { } | ||
|
|
||
| @_documentation(visibility: public) | ||
| func accountOnboarding(_ accountOnboarding: AccountOnboardingViewController, | ||
| didFailLoadWithError error: Error) { } |
There was a problem hiding this comment.
These were all needed so docc would mark them as "Default implementation provided"
| podspec = Pod::Specification.from_file(File.join_if_safe($ROOT_DIR, m['podspec'])) | ||
| index_content += "**[#{podspec.name}](../../#{m['framework_name'].downcase}/documentation/#{m['framework_name'].downcase})**\n\n#{podspec.summary}\n\n" | ||
| modules | ||
| .sort_by { |m| m['framework_name'] } |
There was a problem hiding this comment.
Alphabetizes the root page
| public func encode(to encoder: Encoder) throws { | ||
| var container = encoder.container(keyedBy: StringCodingKey.self) | ||
| try container.encode(appearance.asDictionary(traitCollection: traitCollection), forKey: StringCodingKey("variables")) | ||
| func encode(to encoder: Encoder) throws { |
There was a problem hiding this comment.
Since the struct is internal, no need to make this function public
| var baseURL: URL = StripeConnectConstants.connectJSBaseURL | ||
|
|
||
| var publicKeyOverride: String? = nil | ||
|
|
||
| var publicKeyOverride: String? |
There was a problem hiding this comment.
linter autofix
davidme-stripe
approved these changes
Dec 20, 2024
mludowise-stripe
added a commit
that referenced
this pull request
Dec 20, 2024
Updates 2.24.0 docs with fixes from #4384 Co-authored-by: Bitrise CI <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
README is now included in the StripeConnect docs root page
Root cause: A placeholder
Docs.docc/StripeConnect.mdfile needed to be included in the project. Thebuild_documentationscript copies the README contents into this file and because docc uses xcodebuild, it can only reference it if it's in the project.Fixed anchor tag links that were using incorrect casing
Root cause: docc is case-sensitive when generating anchor tags from headers, so these links didn't work on the docs site on pages that included the README. The change is compatible with Github as it's case-insensitive.
Now generating docs for API gated behind
@_spi(ConnectPrivateBeta)Docc excludes SPI from docs since it's not public, however adding the
@_documentation(visibility: public)fixes the issue. Unfortunately, this needs to be individually added to every SPI-reference to make it generate to docs, not just the enclosing type.Removed deprecation "hack" from
build_documentationThis was a workaround for the following docc bug, which has since been fixed:
AvailabilityParser marks
iOSApplicationExtension, unavailable-annotated properties as universally deprecated swiftlang/swift-docc#450Cleaned up docstring references in Connect
Various minor fixes to docstrings like formatting the
seealsosections using Markdoc.Alphabetized modules on root page
Motivation
https://jira.corp.stripe.com/browse/MXMOBILE-3003
Testing
deploy-docsworkflow on that branch: https://app.bitrise.io/build/b7abb0d9-9e19-4705-8550-c12c549b6785python3 -m http.server 4242to locally serve the resulting docs siteChangelog
n/a